// *************************************************************************************************
// The MIT License (MIT)
// 
// Copyright (c) 2016 Sean
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// *************************************************************************************************
// Project source: https://github.com/theoxuan/FlexiSocket

namespace QFramework
{
    /// <summary>
    /// A client token used at server side
    /// </summary>
    public interface ISocketClientToken
    {
        /// <summary>
        /// Client unique id
        /// </summary>
        /// <remarks>
        /// This will be different at each runtime, so don't use this for authetication
        /// </remarks>
        int ID { get; }

        /// <summary>
        /// Close the client token
        /// </summary>
        void Close();

        /// <summary>
        /// Send message to this client token
        /// </summary>
        /// <param name="message">Raw message</param>
        /// <remarks>
        /// This won't block the main thread
        /// <para/>
        /// <see cref="ISocketServer.SentToClient"/> will be invoked on the async thread if you call this
        /// </remarks>
        void Send(byte[] message);

        /// <summary>
        /// Send message to this client token
        /// </summary>
        /// <param name="message">String message</param>
        /// <remarks>
        /// This won't block the main thread
        /// <para/>
        /// <see cref="ISocketServer.SentToClient"/> will be invoked on the async thread if you call this
        /// </remarks>
        void Send(string message);
    }
}